From 696e4fe50e4282a996472cef7ae06b6a1c7be04e Mon Sep 17 00:00:00 2001
From: Szilard Nemeth <snemeth@apache.org>
Date: Fri, 4 Sep 2020 09:59:13 +0200
Subject: [PATCH] Typos in YarnScheduler#allocate method's doc comment.
 Contributed by Siddharth Ahuja

---
 .../scheduler/YarnScheduler.java              | 27 +++++++++++--------
 1 file changed, 16 insertions(+), 11 deletions(-)

diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.java b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.java
index 5c491383a1..c38663700a 100644
--- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.java
+++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/YarnScheduler.java
@@ -127,17 +127,22 @@ public interface YarnScheduler extends EventHandler<SchedulerEvent> {
   public int getNumClusterNodes();
   
   /**
-   * The main api between the ApplicationMaster and the Scheduler.
-   * The ApplicationMaster is updating his future resource requirements
-   * and may release containers he doens't need.
-   * 
-   * @param appAttemptId
-   * @param ask
-   * @param schedulingRequests
-   * @param release
-   * @param blacklistAdditions
-   * @param blacklistRemovals
-   * @param updateRequests     @return the {@link Allocation} for the application
+   * The main API between the ApplicationMaster and the Scheduler.
+   * The ApplicationMaster may request/update container resources,
+   * number of containers, node/rack preference for allocations etc.
+   * to the Scheduler.
+   * @param appAttemptId the id of the application attempt.
+   * @param ask the request made by an application to obtain various allocations
+   * like host/rack, resource, number of containers, relaxLocality etc.,
+   * see {@link ResourceRequest}.
+   * @param schedulingRequests similar to ask, but with added ability to specify
+   * allocation tags etc., see {@link SchedulingRequest}.
+   * @param release the list of containers to be released.
+   * @param blacklistAdditions places (node/rack) to be added to the blacklist.
+   * @param blacklistRemovals places (node/rack) to be removed from the
+   * blacklist.
+   * @param updateRequests container promotion/demotion updates.
+   * @return the {@link Allocation} for the application.
    */
   @Public
   @Stable